home *** CD-ROM | disk | FTP | other *** search
/ SGI Performance Co-Pilot 1.3 / SGI Performance Co-Pilot 1.3.iso / dist / dist6.4 / pcp.idb / usr / share / catman / u_man / cat1 / pmlc.z / pmlc
Text File  |  1997-04-03  |  17KB  |  328 lines

  1.  
  2.  
  3.  
  4. PPPPMMMMLLLLCCCC((((1111))))                                                                PPPPMMMMLLLLCCCC((((1111))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      ppppmmmmllllcccc - configure active Performance Co-Pilot pmlogger(s) interactively
  10.  
  11. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.      ppppmmmmllllcccc [----eeeeiiii] [----hhhh _h_o_s_t] [----nnnn _n_a_m_e_s_p_a_c_e] [----zzzz | ----ZZZZ _t_i_m_e_z_o_n_e] [----PPPP | _p_i_d]
  13.  
  14. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  15.      ppppmmmmllllcccc may be used to change which metrics and instances a ppppmmmmllllooooggggggggeeeerrrr(1)
  16.      writes to an archive, the frequency with which the metrics are collected
  17.      and whether the logging is mandatory, advisory, on or off.  It also
  18.      reports the current logging status of metrics and instances.  ppppmmmmllllcccc may be
  19.      used to control pmlogger instances on remote hosts as well as those on
  20.      the local host.
  21.  
  22.      Normally ppppmmmmllllcccc operates on the default Performance Metrics Namespace
  23.      (PMNS), however if the ----nnnn option is specified an alternative namespace is
  24.      loaded from the file _n_a_m_e_s_p_a_c_e.
  25.  
  26.      If the ----PPPP option is specified, ppppmmmmllllcccc will attempt to start with a
  27.      connection to the primary pmlogger on the local host.  Alternatively, if
  28.      _p_i_d is specified, a connection to the pmlogger instance with that process
  29.      id will be attempted on startup.  The ----hhhh option may only be used if ----PPPP or
  30.      a _p_i_d is also specified.  In that case ppppmmmmllllcccc will initially connect to the
  31.      specified (remote) pmlogger instance on _h_o_s_t rather than the local host.
  32.      If the connection to the specified pmlogger instance cannot be
  33.      established, ppppmmmmllllcccc will start with no connection.  These options typically
  34.      allow the same file of ppppmmmmllllcccc commands to be directed to multiple pmlogger
  35.      instances by varying the command line arguments.  Note that ----PPPP, _p_i_d and
  36.      ----hhhh are used only when making an initial connection to a pmlogger
  37.      instance.  They are not used as defaults if subsequent connections are
  38.      made interactively (see the ccccoooonnnnnnnneeeecccctttt command below).
  39.  
  40.      By default, times reported by ppppmmmmllllcccc are displayed in the the local time of
  41.      the machine where ppppmmmmllllcccc is running.  If ----zzzz is specified, times will be
  42.      displayed in the time zone of the pmlogger instance from which
  43.      information is being obtained.  If ----ZZZZ is specified, times will be
  44.      displayed in the time zone specified by _t_i_m_e_z_o_n_e, which should be a valid
  45.      time zone specification (see TTTTZZZZ in eeeennnnvvvviiiirrrroooonnnn(5) for details).  Only one of
  46.      ----zzzz or ----ZZZZ may be specified.
  47.  
  48.      If standard input is from a tty, ppppmmmmllllcccc is interactive, with prompts.  The
  49.      ----iiii flag may be used to force interactive behaviour, and would typically
  50.      be used in conjunction with ----eeee to echo all command input on standard
  51.      output.
  52.  
  53.      The following commands may be used:
  54.  
  55.      sssshhhhoooowwww [ llllooooggggggggeeeerrrrssss ] [ @@@@_h_o_s_t ]
  56.          Displays which pmlogger instances are running on the local host (or
  57.          _h_o_s_t, if specified).  The process ids (pids) of all of the available
  58.          pmlogger instances are shown.  The primary pmlogger's is
  59.          parenthesized as it may be referred to by the name "primary" as well
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. PPPPMMMMLLLLCCCC((((1111))))                                                                PPPPMMMMLLLLCCCC((((1111))))
  71.  
  72.  
  73.  
  74.          as by pid.
  75.  
  76.      ccccoooonnnnnnnneeeecccctttt _p_i_d [ @@@@_h_o_s_t ]
  77.      ccccoooonnnnnnnneeeecccctttt pppprrrriiiimmmmaaaarrrryyyy [ @@@@_h_o_s_t ]
  78.          Connects ppppmmmmllllcccc with the specified pmlogger process.  Any existing
  79.          connection to a pmlogger instance is closed first.  Each pmlogger
  80.          instance will accept at most one connection at a time, so if the
  81.          connection is successfully established, your ppppmmmmllllcccc will be the only
  82.          one controlling the pmlogger instance it is connected to.
  83.  
  84.      nnnneeeewwww vvvvoooolllluuuummmmeeee
  85.          This command works only while a connection to a pmlogger instance is
  86.          established.  It tells the pmlogger to close the current volume of
  87.          the log and open a new volume.  Closed volumes may be archived, e.g.
  88.          as part of a regular log management procedure to control the size of
  89.          the physical log files.
  90.  
  91.      ssssttttaaaattttuuuussss
  92.          This command works only while a connection to a pmlogger instance is
  93.          established.  It prints information about the state of the pmlogger
  94.          instance and its associated log.
  95.  
  96.      ttttiiiimmmmeeeezzzzoooonnnneeee llllooooccccaaaallll | llllooooggggggggeeeerrrr | """"_t_i_m_e_z_o_n_e""""
  97.          This command sets the time zone used when times are printed.  llllooooccccaaaallll
  98.          means use the time zone of the machine that ppppmmmmllllcccc is running on.
  99.          llllooooggggggggeeeerrrr means use the time zone of the machine where the pmlogger
  100.          instance is running.  Alternatively an explicit _t_i_m_e_z_o_n_e enclosed in
  101.          quotes may be supplied (refer to TTTTZZZZ in eeeennnnvvvviiiirrrroooonnnn(5) for details).  The
  102.          default time zone is llllooooccccaaaallll unless one of the ----zzzz or ----ZZZZ options was
  103.          supplied on the command line when ppppmmmmllllcccc was started.
  104.  
  105.      fffflllluuuusssshhhh
  106.          This command works only while a connection to a pmlogger instance is
  107.          established, and requests the pmlogger instance to flush to disk all
  108.          buffers associated with the current archive.  For old-timers, ssssyyyynnnncccc is
  109.          a synonym for fffflllluuuusssshhhh.
  110.  
  111.      hhhheeeellllpppp
  112.          Displays a summary of the available commands.
  113.          hhhh and ???? are synonyms for hhhheeeellllpppp.
  114.  
  115.      qqqquuuuiiiitttt
  116.          Exits from ppppmmmmllllcccc.
  117.  
  118.      The remaining commands query and change the logging state of metrics and
  119.      instances.  They will work only if ppppmmmmllllcccc has a connection to a pmlogger
  120.      instance.  Metrics may be specified as fully qualified names (e.g.
  121.      hinv.ncpu) or subtrees of the Performance Metrics Name Space (PMNS) (e.g.
  122.      hinv) which are expanded to include all metrics in the subtree (e.g.
  123.      hinv.ncpu, hinv.cpuclock, etc.).  Lists of metrics may be specified by
  124.      enclosing them in braces with spaces (or a comma) between metrics (e.g.
  125.      {hinv.ncpu hinv.ndisk}).  Subtrees of metrics may be included in such
  126.  
  127.  
  128.                                                                         PPPPaaaaggggeeee 2222
  129.  
  130.  
  131.  
  132.  
  133.  
  134.  
  135. PPPPMMMMLLLLCCCC((((1111))))                                                                PPPPMMMMLLLLCCCC((((1111))))
  136.  
  137.  
  138.  
  139.      lists.
  140.  
  141.      Each individual metric specification may further be qualified with a
  142.      space (or comma) separated list of instances in square brackets (e.g.
  143.      irix.kernel.all.load["1 minute", "5 minute"]).  External instance names
  144.      or numeric internal instance identifiers or both may be used in the same
  145.      list (e.g. sample.colour.[red,1,"blue"]).  If an instance qualification
  146.      is applied to a subtree of the PMNS all of the metrics in the subtree
  147.      must have the same instance domain.  Instance qualifications may not be
  148.      applied to entire lists of metrics but may appear inside such lists.
  149.  
  150.      If no instances are specified for a metric, all instances are used.  All
  151.      instances means all instances available at the time the pmlogger instance
  152.      in question fetches the metrics for logging.  If an instance domain
  153.      changes over time this is not always the same as the set of instances
  154.      displayed by ppppmmmmllllcccc, which can only display the currently available
  155.      instances.  To prevent unintentional errors, only the instances that are
  156.      currently available to ppppmmmmllllcccc may appear in instance specifications.
  157.  
  158.      qqqquuuueeeerrrryyyy _m_e_t_r_i_c_l_i_s_t
  159.          The current logging state of each metric (and instances, where
  160.          applicable) in _m_e_t_r_i_c_l_i_s_t is displayed.  This includes the logging
  161.          state (e.g. on, maybe, off) and the logging interval for each metric
  162.          (and instances) requested.  The following abbreviations pertaining to
  163.          metrics (and instances) may appear in the output:  aaaaddddvvvv, advisory;
  164.          mmmmaaaannnndddd, mandatory; nnnnllll, not in the log; nnnnaaaa, in the log but not currently
  165.          available from it's Performance Metrics Domain Agent (PMDA).  Where
  166.          appropriate, an instance name will appear last on a line preceded by
  167.          its numeric internal instance identifier.
  168.  
  169.      [ lllloooogggg ] mmmmaaaannnnddddaaaattttoooorrrryyyy oooonnnn _i_n_t_e_r_v_a_l _m_e_t_r_i_c_l_i_s_t
  170.          This form of the lllloooogggg command turns on logging for the metrics (and
  171.          any instances) in _m_e_t_r_i_c_l_i_s_t.  _i_n_t_e_r_v_a_l specifies how often the
  172.          specified metrics/instances should be logged.  oooonnnncccceeee indicates that
  173.          the metrics/instances should appear at most once in the log.  More
  174.          often one would use the optional keyword eeeevvvveeeerrrryyyy followed by a positive
  175.          number and one of mmmmiiiilllllllliiiisssseeeeccccoooonnnndddd (or mmmmsssseeeecccc), sssseeeeccccoooonnnndddd (or sssseeeecccc), mmmmiiiinnnnuuuutttteeee (or
  176.          mmmmiiiinnnn), hhhhoooouuuurrrr or their plurals.
  177.          Internal limitations require the _i_n_t_e_r_v_a_l to be smaller than
  178.          (approximately) 74 hours.  An _i_n_t_e_r_v_a_l value of zero is a synonym for
  179.          oooonnnncccceeee.
  180.  
  181.      [ lllloooogggg ] mmmmaaaannnnddddaaaattttoooorrrryyyy ooooffffffff _m_e_t_r_i_c_l_i_s_t
  182.          This tells the pmlogger instance not to log any of the
  183.          metrics/instances in _m_e_t_r_i_c_l_i_s_t.
  184.  
  185.      [ lllloooogggg ] mmmmaaaannnnddddaaaattttoooorrrryyyy mmmmaaaayyyybbbbeeee _m_e_t_r_i_c_l_i_s_t
  186.          This tells the pmlogger instance to honour any subsequent advisory
  187.          logging requests for the metrics/instances in _m_e_t_r_i_c_l_i_s_t.  If the
  188.          current logging state of the metrics/instances is mandatory (either
  189.          on or off) the new state will be set to maybe (effectively advisory
  190.          off).  If the current state of the metrics/instances is already
  191.  
  192.  
  193.                                                                         PPPPaaaaggggeeee 3333
  194.  
  195.  
  196.  
  197.  
  198.  
  199.  
  200. PPPPMMMMLLLLCCCC((((1111))))                                                                PPPPMMMMLLLLCCCC((((1111))))
  201.  
  202.  
  203.  
  204.          advisory (either on or off) the state(s) for the metrics/instances
  205.          will remain as they are.
  206.  
  207.      [ lllloooogggg ] aaaaddddvvvviiiissssoooorrrryyyy oooonnnn _i_n_t_e_r_v_a_l _m_e_t_r_i_c_l_i_s_t
  208.      [ lllloooogggg ] aaaaddddvvvviiiissssoooorrrryyyy ooooffffffff _m_e_t_r_i_c_l_i_s_t
  209.          Advisory logging is only applicable if the last logging state
  210.          specified for a metric/instance was "mandatory maybe" (which permits
  211.          subsequent advisory logging control) or if the logging state is
  212.          already advisory.  These two forms of statement turn advisory logging
  213.          on or off (respectively) for the specified metrics/instances.
  214.          The interpretation for _i_n_t_e_r_v_a_l is as above for the mmmmaaaannnnddddaaaattttoooorrrryyyy case.
  215.  
  216.      There is no continuation character required for commands that span lines.
  217.  
  218.      The word aaaatttt may be used interchangeably with @@@@.
  219.  
  220.      A request to log all instances of a metric will supersede any prior
  221.      request to log either all or specific instances of a metric (if the
  222.      request specifies a permissible transition in the logging state).  A
  223.      request to log specific instances of a metric when all instances of a
  224.      metric are already being logged is refused by ppppmmmmllllooooggggggggeeeerrrr.
  225.  
  226. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  227.      ppppmmmmllllooooggggggggeeeerrrr(1), ppppmmmmdddduuuummmmpppplllloooogggg(1)
  228.  
  229. DDDDIIIIAAAAGGGGNNNNOOOOSSSSTTTTIIIICCCCSSSS
  230.      Most error or warning messages are self-explanatory.  A message of the
  231.      form
  232.              Warning: unable to change logging state for...
  233.      followed by a list of metrics (and possibly instances) indicates that
  234.      ppppmmmmllllooooggggggggeeeerrrr refused the request for the metrics (and instances) that appear.
  235.      Any metrics (and instances) that were specified but don't appear in the
  236.      message have had their logging state updated successfully (no news is
  237.      good news).  Usually this warning results from requesting advisory
  238.      logging when a mandatory control is already in place, or requesting
  239.      logging for specific instances when all instances are already being
  240.      logged.
  241.  
  242. CCCCAAAAVVVVEEEEAAAATTTT
  243.      If all instances of a metric are being logged and a request is made to
  244.      log specific instances of the metric with the same state and frequency,
  245.      the request may appear to succeed, even though ppppmmmmllllooooggggggggeeeerrrr has refused the
  246.      request.  This is not normally a problem, as the required information
  247.      will still be placed into the log by ppppmmmmllllooooggggggggeeeerrrr.
  248.  
  249.      However in the case where the metric is to be logged once, the outcome is
  250.      not what might be expected.  When ppppmmmmllllooooggggggggeeeerrrr receives a request to log a
  251.      metric once, it places the current value(s) of the metric into the log as
  252.      soon as it can, regardless of whether the metric is already in the log.
  253.      This may be used to force values into the log.  When a request to log
  254.      specific instances of a metric arrives and is refused because all
  255.      instances of the metric are already being logged, ppppmmmmllllooooggggggggeeeerrrr does not place
  256.  
  257.  
  258.                                                                         PPPPaaaaggggeeee 4444
  259.  
  260.  
  261.  
  262.  
  263.  
  264.  
  265. PPPPMMMMLLLLCCCC((((1111))))                                                                PPPPMMMMLLLLCCCC((((1111))))
  266.  
  267.  
  268.  
  269.      values for the instances requested into the log.  It returns the current
  270.      logging state for each instance requested to ppppmmmmllllcccc.  The requested and
  271.      returned states are identical, so ppppmmmmllllcccc doesn't raise an error as it
  272.      should.
  273.  
  274.      To ensure that only certain instances of a metric are being logged, one
  275.      should always turn off logging for all instances of the metric prior to
  276.      turning on logging for the specific instances required.
  277.  
  278.  
  279.  
  280.  
  281.  
  282.  
  283.  
  284.  
  285.  
  286.  
  287.  
  288.  
  289.  
  290.  
  291.  
  292.  
  293.  
  294.  
  295.  
  296.  
  297.  
  298.  
  299.  
  300.  
  301.  
  302.  
  303.  
  304.  
  305.  
  306.  
  307.  
  308.  
  309.  
  310.  
  311.  
  312.  
  313.  
  314.  
  315.  
  316.  
  317.  
  318.  
  319.  
  320.  
  321.  
  322.  
  323.  
  324.                                                                         PPPPaaaaggggeeee 5555
  325.  
  326.  
  327.  
  328.